Skip to content

chore(release): v1.3.0 - Full Rolling Year, Speed Fixes, and Docs Polish - #23

Merged
miccy merged 29 commits into
mainfrom
v1.3.0
Jan 29, 2026
Merged

miccy merged 29 commits into
mainfrom
v1.3.0

Conversation

@miccy

@miccy miccy commented Jan 29, 2026 •

Copy link
Copy Markdown
Owner

Release v1.3.0

🚀 Major Improvements

  • Full Rolling Year: Fixed the contribution graph to show a complete rolling year (53 weeks) ending on the current date, ensuring no empty columns at the start.
  • Optimized Animation: Adjusted default frame delay to 60ms for a smoother, faster animation (previously too slow).
  • Accurate Data: Improved parsing to use data-count when available and robustly approximate from data-level otherwise.
  • GIF Support: Added docs/guides/gif-implementation.md as a planned feature for v1.3.0 (Jan 2026).
  • Glass Theme: Validated and documented.

🐛 Bug Fixes

  • Week Alignment: Fixed grid alignment to consistently start on Sunday, matching standard GitHub contribution graphs.
  • UTC Date Parsing: Fixed potential timezone issues where days could shift.
  • Robust Fetch: Added error handling for previous year fetches to gracefully handle new users or API errors.

📝 Documentation

  • Updated roadmap.md to reflect 2025 timeline.
  • Corrected theme lists in packages/renderer/README.md.
  • Added Unit Test stats and portable instructions.

✅ Verification

  • Added quality script to root package.json.
  • All tests passed (104+ tests).
  • Smoke tests generated valid SVGs.

Summary by CodeRabbit

  • New Features

    • GIF animation rendering; 12‑month rolling contribution window; REST API docs/endpoints; refined renderer visuals (tapered segments & opacity)
  • Documentation

    • Streamlined README; many package READMEs added/updated; GIF guide and roadmap added; release setup and Docker dev guides added; legacy architecture and SECURITY docs removed
  • Changes

    • Node requirement bumped to >=24; Bun upgraded to 1.3.7; packages bumped to 1.3.0; total tests now 223; quality scripts consolidated
  • Chores

    • CLI default frame delay changed 150ms → 60ms

✏️ Tip: You can customize this high-level summary in your review settings.

Copilot AI review requested due to automatic review settings January 29, 2026 12:42
@coderabbitai

coderabbitai Bot commented Jan 29, 2026 •

Copy link
Copy Markdown
Contributor
📝 Walkthrough

Walkthrough

Adds v1.3.0 updates: rolling 12‑month contribution window in the GitHub client, renderer visual tapering and related test updates, CLI default frame-delay change, numerous docs/README additions and removals, Node/Bun and package version bumps, script/workflow reorganizations, and CI/tooling adjustments.

Changes

Cohort / File(s) Summary
Root manifest & scripts
package.json, turbo.json, biome.json
Version bumps to 1.3.0, Node engine → >=24, bun → 1.3.7; scripts reorganized (add check, typecheck, quality; remove legacy scripts); turbo task cache/output adjustments.
Workflows & CI
.github/workflows/ci.yml, .github/workflows/generate-demo.yml, action.yml
Bumped Bun setup to 1.3.7 and renamed type-check → typecheck occurrences; no runtime behavior changes.
Workspace & review config
.vscode/snake-evolution.code-workspace, .coderabbit.yaml
Workspace tree renamed/reorganized; review config adds path-specific content instructions for docs/testing/** and root *.md.
Top-level docs & changelogs
README.md, CHANGELOG.md, SECURITY.md (removed), docs/*
README rewritten, changelog updates added; SECURITY.md and several long-form docs removed; new RELEASE_SETUP.md added.
Web docs & testing docs
apps/web/src/content/docs/*, apps/web/.../testing/*
Added roadmap and GIF implementation guide; testing docs converted to YAML front matter and test stats updated.
GitHub client
packages/github/src/index.ts
Implements rolling 12‑month window: fetchYear helper, dual-year fetch for current-year rolling window, dedupe/merge/slice last 365 days, Sunday-aligned grid reconstruction, and resilient error handling.
Renderer
packages/renderer/src/index.ts, packages/renderer/src/renderer.test.ts, packages/renderer/*
Static SVG now renders tapered segments (varying size/opacity/rx per segment); tests updated to assert tapering and head/body rx differences; package bumped and docs added.
CLI
packages/cli/src/index.ts, packages/cli/package.json
Default --frame-delay changed from 150ms → 60ms; package version/engines/devDependency bumps.
Monorepo packages & READMEs
packages/*/package.json, packages/*/README.md
Many packages bumped to 1.3.0 and new/updated READMEs added (engine, github, renderer, types, ui, ts-config, biome-config).
Tests
__tests__/package-config.test.ts, __tests__/docs/documentation.test.ts
Tests updated for Node >=24, script renames (quality→check, type-check→typecheck), doc path and content expectations adjusted.
Tooling & docs
packages/biome-config/*, packages/typescript-config/*, scripts/README.md, docker/README.md
Biome schema bumps, new shared config READMEs, Docker dev README and scripts docs added.

Sequence Diagram(s)

sequenceDiagram
    participant Client as Caller (CLI/API)
    participant Handler as fetchContributions()
    participant Fetcher as fetchContributionsHTML()
    participant YearFetch as fetchYear(year)
    participant GitHub as GitHub HTML
    participant Parser as parseContributionCalendar()
    participant Merger as MergeRollingWindow

    Client->>Handler: request(username, year)
    Handler->>Fetcher: fetchContributionsHTML(username, year)

    alt current year (rolling)
        Fetcher->>YearFetch: fetchYear(currentYear)
        Fetcher->>YearFetch: fetchYear(prevYear)
        YearFetch->>GitHub: GET /users/:username/contributions?year=...
        GitHub-->>YearFetch: HTML or 404
        YearFetch-->>Fetcher: parsed days/weeks
    else past year (calendar)
        Fetcher->>YearFetch: fetchYear(targetYear)
        YearFetch->>GitHub: GET /users/:username/contributions?year=targetYear
        GitHub-->>YearFetch: HTML
        YearFetch-->>Fetcher: parsed days/weeks
    end

    Fetcher->>Parser: parse HTML -> day list
    Parser-->>Fetcher: structured days/weeks
    Fetcher->>Merger: merge years, dedupe, slice last 365 days, pad/sunday-align
    Merger-->>Fetcher: merged grid
    Fetcher-->>Handler: contributions grid
    Handler-->>Client: JSON result
Loading

Estimated code review effort

🎯 4 (Complex) | ⏱️ ~60 minutes

Possibly related PRs

Suggested labels

documentation, enhancement

Poem

🐍 Versions climb and docs rearrange,
a rolling year stitched into range.
Snakes now taper, frames run fast,
workflows tuned and tests recast.
v1.3.0 — coiled, polished, and changed.

🚥 Pre-merge checks | ✅ 2 | ❌ 1
❌ Failed checks (1 warning)
Check name Status Explanation Resolution
Docstring Coverage ⚠️ Warning Docstring coverage is 50.00% which is insufficient. The required threshold is 80.00%. Write docstrings for the functions missing them to satisfy the coverage threshold.
✅ Passed checks (2 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title clearly and concisely summarizes the main changes in this release PR: version bump to 1.3.0, rolling year contribution feature, performance improvements, and documentation updates.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing touches
  • 📝 Generate docstrings
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Post copyable unit tests in a comment
  • Commit unit tests in branch v1.3.0

Comment @coderabbitai help to get the list of available commands and usage tips.

@kilo-code-bot

kilo-code-bot Bot commented Jan 29, 2026 •

Copy link
Copy Markdown
Contributor

Code Review Summary

Status: No Issues Found | Recommendation: Merge

Files Reviewed (35 files)
  • .coderabbit.yaml - Configuration updates
  • .github/workflows/ci.yml - Bun version bump
  • .github/workflows/generate-demo.yml - Bun version bump
  • .vscode/snake-evolution.code-workspace - Workspace reorganization
  • CHANGELOG.md - Version 1.3.0 release notes
  • README.md - Major documentation overhaul
  • package.json - Version and dependency updates
  • packages/biome-config/README.md - New package documentation
  • packages/biome-config/biome.json - Schema version update
  • packages/biome-config/package.json - Version bump
  • packages/cli/CHANGELOG.md - Release notes
  • packages/cli/package.json - Version and Node requirement updates
  • packages/cli/src/index.ts - Frame delay reduction
  • packages/engine/CHANGELOG.md - New changelog
  • packages/engine/README.md - New documentation
  • packages/engine/package.json - Version bump
  • packages/github/CHANGELOG.md - New changelog
  • packages/github/README.md - New documentation
  • packages/github/package.json - Version bump
  • packages/github/src/index.ts - Rolling year implementation
  • packages/renderer/CHANGELOG.md - New changelog
  • packages/renderer/README.md - New documentation
  • packages/renderer/package.json - Version bump
  • packages/renderer/src/index.ts - Snake tapering logic
  • packages/renderer/src/renderer.test.ts - Test updates for tapering
  • packages/types/CHANGELOG.md - New changelog
  • packages/types/README.md - New documentation
  • packages/types/package.json - Version bump
  • packages/typescript-config/README.md - New documentation
  • packages/typescript-config/package.json - Version bump
  • packages/ui/README.md - New documentation
  • packages/ui/package.json - Version bump
  • scripts/README.md - New documentation
  • turbo.json - Task configuration changes

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR releases version 1.3.0 of Snake Evolution, focusing on implementing a full rolling year contribution window, performance optimizations, and comprehensive documentation improvements. The release transitions the project to show a complete 12-month rolling contribution window ending on the current date, fixes animation speed defaults, and adds extensive package-level documentation.

Changes:

  • Full rolling year implementation with proper Sunday alignment and merged data from current + previous year
  • Default frame delay optimized from 150ms to 60ms for smoother animations
  • Comprehensive README documentation added to all packages and directories
  • Node.js requirements updated to >=24 with Bun 1.3.7
  • Script consolidation in root package.json (30 → 21 scripts)
  • Version bumps across all packages to 1.3.0

Reviewed changes

Copilot reviewed 50 out of 58 changed files in this pull request and generated 11 comments.

Show a summary per file
File Description
packages/github/src/index.ts Core rolling year implementation with dual-year fetching, Sunday alignment, and UTC date parsing
packages/cli/src/index.ts Frame delay default changed from 150ms to 60ms
packages/cli/package.json Node requirement updated to >=24, @types/node downgraded to ^24.0.0
package.json Script consolidation, Bun 1.3.7 upgrade, dependency updates
turbo.json Removed test caching and unused task configurations
README.md Major restructuring with simplified quick start and copyright changes
apps/web/src/content/docs/guides/gif-implementation.md New comprehensive GIF implementation guide (planned feature)
apps/web/src/content/docs/roadmap.md New roadmap with 2026 dates and strategic positioning
Multiple package README files New documentation for all packages and directories
CHANGELOG.md Release notes with added/changed/fixed/removed sections

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/github/src/index.ts Resolved
Comment thread CHANGELOG.md Resolved
Comment thread .vscode/snake-evolution.code-workspace Resolved
Comment thread apps/web/src/content/docs/roadmap.md Resolved
Comment thread packages/cli/src/index.ts Resolved
Comment thread packages/github/src/index.ts Resolved
Comment thread README.md Resolved
Comment thread turbo.json Resolved
Comment thread README.md Resolved

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 6a7fdf1a22

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread package.json Resolved

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 7

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (2)
__tests__/package-config.test.ts (2)

27-31: Pipeline failure: Node.js version regex mismatch 🚨The CI pipeline is failing because the test expects engines.node to match />=\s*22/ but Node.js 24.x is now the Active LTS version (codename "Krypton"), and it appears package.json has been updated to require >=24.

The test regex needs to be updated to match the new Node.js requirement:

🔧 Fix to align test with updated Node.js requirement
     test("should specify Node.js >= 22", () => {
+    test("should specify Node.js >= 24", () => {
       expect(pkg.engines).toBeDefined();
       const engines = pkg.engines as Record<string, string>;
-      expect(engines.node).toMatch(/>=\s*22/);
+      expect(engines.node).toMatch(/>=\s*24/);
     });

195-200: Update test to require Node.js >= 24

Both package.json and packages/cli/package.json specify "node": ">=24", but this test is checking for >=22. The test name and regex pattern need to be updated to match the actual engine requirement.

Suggested fix
-   test("should require Node.js >= 22", () => {
+   test("should require Node.js >= 24", () => {
      expect(pkg.engines).toBeDefined();
      const engines = pkg.engines as Record<string, string>;

-     expect(engines.node).toMatch(/>=\s*22/);
+     expect(engines.node).toMatch(/>=\s*24/);
     });
🤖 Fix all issues with AI agents
In @.vscode/snake-evolution.code-workspace:
- Around line 11-14: Remove the duplicated workspace folder entry that points to
"../apps/api": locate the two JSON objects with "path": "../apps/api" (the
entries whose "name" values are "      |___⚡ API" and "⚡ apps/api") and delete
one of them so the apps/api folder appears only once in the workspace; keep
whichever "name" label you prefer and ensure the remaining entry still has
"path": "../apps/api".

In `@apps/web/src/content/docs/guides/gif-implementation.md`:
- Line 10: Update the status line "**Status: Planned for v1.3.0 (January
2026)**" to indicate the feature is released; replace it with a phrase such as
"**Status: Released in v1.3.0**" or "**Implemented in v1.3.0**" so the document
reflects this PR being the v1.3.0 release (locate the line containing the exact
status text and edit it accordingly).

In `@apps/web/src/content/docs/roadmap.md`:
- Around line 8-9: Update the roadmap entries so they aren’t “past-dated future”
items: locate the "**Updated:** January 2026" header and the timeline lines
referencing "Q1–Q3 2025" and "January 2025" and either (a) mark those items as
completed/retrospective with a short completion note and date, or (b) shift
their dates to current/future targets and adjust statuses to "In
Progress"/"Planned"; ensure similar edits are applied to all affected lines
(around lines 46–127) so the document’s dates/statuses are consistent and not
misleading.
- Around line 19-33: Update the Market Context and Our Opportunity sections to
add sourcing and timestamping: append "as of <month year>" to each star count
and the TARGET line, and add inline citations or link references for the GitHub
star numbers and any target rationale; specifically change the strings under the
"### Market Context" bullet points and the text block under "### Our
Opportunity" (including the gitfiti, github-activity, Snake Evolution lines and
"TARGET: 10K ⭐ in 6 months") to include either a parenthetical source URL or a
footnote-style citation and a last-updated date so readers can verify and know
when the metrics were recorded.

In `@apps/web/src/content/docs/testing/unit-tests-generated.md`:
- Around line 184-186: Replace the confusing placeholder line "cd <repo-root>"
in the command block with a clear instruction to run the command from the
repository root; specifically, update the doc lines that currently show "cd
<repo-root>" and "bun test" so the text reads something like "Run all tests from
the repository root" followed by the "bun test" command (leave "bun test"
unchanged) to avoid readers typing the literal placeholder.

In `@packages/biome-config/README.md`:
- Around line 9-13: Update the example JSON in README.md so the "$schema" value
matches the project's Biome version: replace
"https://biomejs.dev/schemas/2.0.6/schema.json" with
"https://biomejs.dev/schemas/2.3.13/schema.json" in the JSON snippet (the line
containing "$schema") to keep the documentation consistent with the biome.json
files.

In `@README.md`:
- Around line 62-68: Update the GitHub Actions step "Push to Output Branch" that
currently uses crazy-max/ghaction-github-pages@v3.1.0 to the latest major (use
`@v4` or pin to `@v4.2.0`); edit the action reference string in the workflow example
so the uses line reads crazy-max/ghaction-github-pages@v4 (or `@v4.2.0`) while
leaving the surrounding keys (target_branch, build_dir, env, GITHUB_TOKEN)
unchanged.
🧹 Nitpick comments (8)
packages/types/README.md (1)

32-34: Minor doc polish: hyphenate compound adjective.
“Full-year” reads better as a modifier.

✏️ Suggested tweak
-| `ContributionGrid` | Full year contribution grid |
+| `ContributionGrid` | Full-year contribution grid |
.vscode/snake-evolution.code-workspace (1)

39-50: External paths may not exist for other contributors.

The workspace includes paths that reference directories outside the repository (../../snake-knowledge, ../../contributions-devouring-snake, ../../). These appear to be developer-specific folders that won't exist for other contributors cloning this repo.

If this workspace file is meant to be shared, consider either:

  1. Removing these external references, or
  2. Adding a comment explaining these are optional/personal additions

If it's intentionally a personal setup, this is fine — just wanted to flag it in case it was unintentional! 🙂

packages/github/src/index.ts (3)

207-223: Good graceful degradation for new users.

The error handling correctly swallows 404s for the previous year (new users won't have data) while propagating other errors like rate limits or network issues. This is a nice touch for robustness!

One small note: the string matching on "User not found" or "404" (line 213) is somewhat fragile. If the error message format changes, this could break. Consider also checking for the error type or status code if available.


245-247: Deduplication works but could be more efficient.

The findIndex approach is O(n²) for deduplication. For the typical ~730 days of data this is fine, but if you ever need to optimize, a Set or Map keyed by date would be O(n).

Not urgent, just a note for the future!


363-372: Sunday alignment logic is duplicated.

This UTC-based Sunday alignment (lines 363-372) mirrors the logic in fetchContributionsHTML (lines 280-286). Consider extracting to a shared helper function if you want to reduce duplication, though it's not critical.

packages/renderer/README.md (2)

57-57: Clarify the version reference for Glass theme.

The note states "GIF only, v1.1+" but this PR is releasing v1.3.0. Should this reference be updated to reflect the actual release version where Glass theme support was introduced?


39-45: Consider documenting GIF rendering APIs.

The API table focuses exclusively on SVG rendering functions, but the package also exports renderAnimatedGIF and renderAnimatedGIFSampled (documented in the GIF implementation guide). While the README describes itself as "SVG renderer", users might benefit from a note pointing to the GIF guide or a brief mention that GIF rendering is also available.

apps/web/src/content/docs/guides/gif-implementation.md (1)

144-146: Consider stricter validation for sampleRate.

The current logic treats sampleRate <= 1 as "no sampling," which means a value of 0 or negative would be silently treated as 1. Consider adding validation to ensure sampleRate is a positive number.

✨ Suggested validation improvement
 export async function renderAnimatedGIFSampled(
   frames: SnakeFrame[],
   options: GifOptions & { sampleRate?: number } = {}
 ): Promise<Buffer> {
   const { sampleRate = 1, ...gifOptions } = options;

+  if (sampleRate < 1) {
+    throw new Error("sampleRate must be >= 1");
+  }
+
   if (sampleRate <= 1) {
     return renderAnimatedGIF(frames, gifOptions);
   }

Comment thread .vscode/snake-evolution.code-workspace Resolved
Comment thread apps/web/src/content/docs/roadmap.md Resolved
Comment thread packages/biome-config/README.md Resolved
Comment thread README.md Resolved
Repository owner deleted a comment from socket-security Bot Jan 29, 2026
@miccy miccy self-assigned this Jan 29, 2026
@miccy miccy added bug Something isn't working docs Improvements or additions to documentation labels Jan 29, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 2

🤖 Fix all issues with AI agents
In `@__tests__/docs/documentation.test.ts`:
- Around line 16-21: The test currently allows any markdown heading level
because hasHeading uses /^#+\s*.*Snake Evolution/i; tighten this to match only
H1 or an explicit <h1> by changing the hasHeading pattern to require a single
leading '#' (e.g. /^#\s*Snake Evolution/i) and add an HTML <h1> check (e.g.
/<h1.*>.*Snake Evolution.*<\/h1>/i) so the test function ("should have main
heading or banner") only passes for a true main heading or the existing banner
check; update the hasHeading/hasBanner logic in the test accordingly
(referencing hasHeading, hasBanner, readmePath, content).

In `@package.json`:
- Around line 25-27: The root package.json scripts create an infinite loop
because "typecheck" runs "turbo run type-check" which in turn runs the root's
"type-check" (which calls "bun run typecheck"); fix by changing the "typecheck"
script to invoke Turbo only for workspace packages and explicitly exclude the
root (use Turbo's --filter or negated filter syntax to omit the root package) so
"typecheck" no longer triggers the root "type-check"; update the "typecheck"
script entry to use a Turbo filter excluding the root while leaving "type-check"
and "check" unchanged.
🧹 Nitpick comments (4)
__tests__/docs/documentation.test.ts (1)

211-217: Remove duplicate doc entries to avoid redundant checks
Both lists include ../../.github/CONTRIBUTING.md twice, which adds unnecessary work and noise in failures.

Suggested cleanup
       const docs = [
         "../../README.md",
-        "../../.github/CONTRIBUTING.md",
-        "../../.github/CONTRIBUTING.md",
+        "../../.github/CONTRIBUTING.md",
         "../../RELEASE_SETUP.md",
         "../../apps/web/src/content/docs/roadmap.md",
       ];
@@
       const docs = [
         { path: "../../README.md", minSize: 2000 },
-        { path: "../../.github/CONTRIBUTING.md", minSize: 3000 },
-        { path: "../../.github/CONTRIBUTING.md", minSize: 3000 },
+        { path: "../../.github/CONTRIBUTING.md", minSize: 3000 },
         { path: "../../RELEASE_SETUP.md", minSize: 500 },
         { path: "../../apps/web/src/content/docs/roadmap.md", minSize: 1000 },
       ];

Also applies to: 232-238

packages/github/src/index.ts (2)

245-247: Consider using a Map for deduplication.

The current findIndex approach is O(n²). With ~730 days max it won't be a problem in practice, but a Map would be cleaner and O(n):

✨ Optional refactor using Map
-  // 3. Remove duplicates (overlap at year boundary?)
-  const uniqueDays = allDays.filter(
-    (day, index, self) => index === self.findIndex((d) => d.date === day.date),
-  );
+  // 3. Remove duplicates (overlap at year boundary?)
+  const dayMap = new Map<string, GitHubContribution>();
+  for (const day of allDays) {
+    if (!dayMap.has(day.date)) {
+      dayMap.set(day.date, day);
+    }
+  }
+  const uniqueDays = Array.from(dayMap.values());

331-357: Regex patterns have a minor attribute-order blind spot.

Both patterns assume data-count appears between data-date and data-level. If GitHub serves HTML like:

<td data-date="2025-01-01" data-level="3" data-count="4">

...the count won't be captured. Not a blocker since the contributionCountFromLevel heuristic kicks in, and the comment on lines 316-317 acknowledges this. Just something to keep in mind if you ever see unexpectedly heuristic-based totals.

💡 Alternative: capture attributes separately

If you wanted bulletproof extraction, you could capture the whole <td> tag and then run separate regex matches for each attribute:

const tdPattern = /<td([^>]*)>/g;
for (const match of html.matchAll(tdPattern)) {
  const attrs = match[1];
  const dateMatch = attrs.match(/data-date="(\d{4}-\d{2}-\d{2})"/);
  const levelMatch = attrs.match(/data-level="(-?\d+)"/);
  const countMatch = attrs.match(/data-count="(\d+)"/);
  if (dateMatch && levelMatch) {
    days.push({
      date: dateMatch[1],
      level: Number.parseInt(levelMatch[1], 10),
      count: countMatch ? Number.parseInt(countMatch[1], 10) : undefined,
    });
  }
}

This handles any attribute order. But again, totally optional—current approach works fine!

README.md (1)

83-103: Consider clarifying the asset path for generated outputs.
The examples reference ./assets/examples/..., which is perfect for this repo, but users running the Action will typically have outputs under dist/ on the output branch. A short note would reduce confusion.

📝 Suggested clarification
 ### Markdown Usage
 
 Add this into your README.md
+_(If using the GitHub Action, reference the generated files from the output branch, e.g., `dist/snake.svg`.)_
 
 ```markdown
 ![GitHub Dark](./assets/examples/github-dark.svg)
</details>

</blockquote></details>

</blockquote></details>

<!-- This is an auto-generated comment by CodeRabbit for review status -->

Comment thread __tests__/docs/documentation.test.ts Resolved
Comment thread package.json Resolved
miccy added 2 commits January 29, 2026 14:28
…or handling, update roadmap dates to 2026, and bump Node.js engine requirement to v24.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 5

🤖 Fix all issues with AI agents
In `@apps/web/src/content/docs/roadmap.md`:
- Around line 19-33: Update the market statistics in the "Market Context" and
"Our Opportunity" sections by appending a timestamp (e.g., "as of Jan 2026") to
each metric and adding verifiable sources: convert lines like "18,000+ GitHub
stars", "5,500+ stars" and the inline block containing "TARGET: 10K ⭐" to
include either a repository link or a GitHub search query reference in
parentheses or square brackets (e.g., "(as of Jan 2026, see [repo-name] or
[GitHub search])"), and change the target timeline text "TARGET: 10K ⭐ in 6
months" to a concrete date like "TARGET: 10K ⭐ by July 2026" so readers can
verify numbers and timeline.
- Line 30: Update the "github-activity" line to remove the all-caps "SKETCHY"
label and replace it with a more measured descriptor (for example "manipulation
tool" or "potentially inauthentic approach"); locate the entry containing the
string "github-activity:    Fake automation, 3.7K ⭐, SKETCHY" and edit the
trailing label to a professional phrasing that preserves the intended warning
without using pejorative all-caps language.

In `@package.json`:
- Line 48: The engines entry currently pins Node to "node": ">=24" but the
codebase doesn't use Node 24-specific features; update the engines field in
package.json (the "node" engines entry) to a lower minimum such as ">=22" (or
">=20" if you verified compatibility), and update any CI configs or
README/tooling that enforce Node 24 to match the new floor to make the project
more inclusive for contributors and CI environments.

In `@packages/github/src/index.ts`:
- Around line 252-258: The date filtering uses toISOString() on local Date
objects (fromDate/toDate) which converts to UTC and can mismatch the local
YYYY-MM-DD values in uniqueDays; fix by generating date strings in UTC
explicitly (use getUTCFullYear/getUTCMonth/getUTCDate) or a small helper to
format dates as YYYY-MM-DD in UTC for fromDate and toDate, and ensure the same
UTC-based strings are used when computing oneYearAgo and when filtering
rollingDays against uniqueDays (refer to oneYearAgo, fromDate, toDate,
rollingDays, uniqueDays).

In `@turbo.json`:
- Around line 24-27: The turbo.json "format" task currently has "cache": true
which prevents the biome format --write . command (the "format" task) from
running on cache hits; change the "format" task's cache property to false
(matching "lint:fix") so the in-place formatter always runs when invoked,
updating the "format" task's "cache" value from true to false.
🧹 Nitpick comments (1)
packages/github/src/index.ts (1)

244-247: Minor: O(n²) deduplication could be simplified.

The current findIndex-based deduplication is O(n²). While the dataset is small (~730 days max), a Map or Set would be more idiomatic and marginally faster:

♻️ Optional refactor using Map
-  const uniqueDays = allDays.filter(
-    (day, index, self) => index === self.findIndex((d) => d.date === day.date),
-  );
+  const dayMap = new Map<string, GitHubContribution>();
+  for (const day of allDays) {
+    if (!dayMap.has(day.date)) {
+      dayMap.set(day.date, day);
+    }
+  }
+  const uniqueDays = Array.from(dayMap.values());

Comment thread apps/web/src/content/docs/roadmap.md Resolved
Comment thread apps/web/src/content/docs/roadmap.md Resolved
Comment thread package.json Resolved
Comment thread packages/github/src/index.ts Resolved
Comment thread turbo.json Resolved
@miccy miccy added the feat New feature or request label Jan 29, 2026
@miccy miccy linked an issue Jan 29, 2026 that may be closed by this pull request
@miccy
miccy requested a review from Copilot January 29, 2026 14:12
Repository owner deleted a comment from socket-security Bot Jan 29, 2026

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@packages/renderer/README.md`:
- Around line 25-33: The README's static render example contains a
duplicated/malformed block: remove the stray incomplete declaration and keep a
single correct call to renderStaticSVG assigning to staticSvg; locate the
duplicated lines around the staticSvg = renderStaticSVG(...) example and ensure
the final code is a single well-formed statement using renderStaticSVG(grid,
snake, { cellSize: 12, gap: 2, palette: 'github-light' }) so only one staticSvg
variable is declared and the object literal is closed properly.

Comment thread packages/renderer/README.md Resolved
@socket-security

socket-security Bot commented Jan 29, 2026 •

Copy link
Copy Markdown

Review the following changes in direct dependencies. Learn more about Socket for GitHub.

Diff Package Supply Chain
Security
Vulnerability Quality Maintenance License
Updated@​types/​bun@​1.3.5 ⏵ 1.3.71001004995 +2100
Updated@​types/​node@​25.1.0 ⏵ 24.10.9100 +110081 +196100

View full report

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Copilot reviewed 52 out of 59 changed files in this pull request and generated 4 comments.

Comments suppressed due to low confidence (1)

.vscode/snake-evolution.code-workspace:38

  • The apps/api folder is defined twice in the workspace configuration. It appears once with the new naming scheme at line 12 (" |___⚡ API") and again with the old naming scheme at lines 35-38 ("⚡ apps/api"). This duplication should be removed to avoid confusion in VS Code.
    {
      "name": "⚡ apps/api",
      "path": "../apps/api"
    }

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread packages/biome-config/README.md Resolved
Comment thread packages/renderer/README.md Resolved
Comment thread packages/github/src/index.ts Resolved
Comment thread packages/github/src/index.ts Resolved
miccy and others added 2 commits January 29, 2026 15:19
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Miccy <code@miccy.dev>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Signed-off-by: Miccy <code@miccy.dev>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@CHANGELOG.md`:
- Around line 32-33: The CI failure is caused by malformed Markdown headings in
CHANGELOG.md; add a blank line above and below each section heading (e.g., "###
Changed" and "### Fixed") and either add content under "### Changed" or remove
the empty "### Changed" heading entirely so no empty section remains; ensure the
resulting file has a blank line separation between headings and their content
(or between consecutive headings) to satisfy the linter.

Comment thread CHANGELOG.md Resolved
miccy and others added 2 commits January 29, 2026 15:26
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Miccy <code@miccy.dev>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Miccy <code@miccy.dev>

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Fix all issues with AI agents
In `@packages/github/src/index.ts`:
- Around line 96-115: The rolling-year branch in packages/github/src/index.ts
computes `from`/`to` using full ISO timestamps that preserve time-of-day
(variables: now, oneYearAgo, from, to), causing inconsistency with calendar-year
mode and the HTML scraping path; modify the rolling-year logic to align the
start to the previous Sunday as you already do but then normalize both `from`
and `to` toUTC date boundaries (set `from` to YYYY-MM-DDT00:00:00Z and `to` to
YYYY-MM-DDT23:59:59Z) so GraphQL and calendar modes use consistent, clean UTC
day-range strings.
🧹 Nitpick comments (1)
packages/github/src/index.ts (1)

205-223: Prefer status-aware errors over string matching for 404 handling.

String checks on error.message can misclassify failures. Attaching status to the error makes the fallback more robust and easier to reason about.

🔧 Example refactor (status-carrying error)
-  if (!response.ok) {
-    if (response.status === 404) throw new Error(`User not found: ${username}`);
-    throw new Error(`GitHub error: ${response.status}`);
-  }
+  if (!response.ok) {
+    const err = new Error(
+      response.status === 404 ? `User not found: ${username}` : `GitHub error: ${response.status}`,
+    ) as Error & { status?: number };
+    err.status = response.status;
+    throw err;
+  }
-    fetchYear(username, currentYear - 1).catch((error) => {
+    fetchYear(username, currentYear - 1).catch((error) => {
+      const status = (error as { status?: number }).status;
       // Only swallow 404s (User not found) or "Not Found" errors
       // Propagate other errors (rate limits, network issues, etc.)
-      const msg = error instanceof Error ? error.message : String(error);
-      if (msg.includes("User not found") || msg.includes("404")) {
+      if (status === 404) {
         return {
           weeks: [],
           totalContributions: 0,
           year: currentYear - 1,
           username,
         } as ContributionGrid;
       }
       throw error;
     }),

Comment thread packages/github/src/index.ts Resolved
Comment thread packages/renderer/src/index.ts Resolved

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Caution

Some comments are outside the diff and can’t be posted inline due to platform limitations.

⚠️ Outside diff range comments (1)
packages/renderer/src/renderer.test.ts (1)

609-616: Test assertions at lines 609-616 won't match the rendered SVG output due to tapering offsets.

The test expects exact string matches like x="3" y="3", but the implementation applies tapering offsets:

  • Head (i=0): sizeMultiplier = 1.3 → segSize = 14 → offset = -1.5 → actual x becomes 3 + (-1.5) = 1.5
  • Second segment (i=1): sizeMultiplier = 0.7 → segSize = 8 → offset = 1.5 → actual x becomes 17 + 1.5 = 18.5

These position assertions will fail. Update the test to either expect the offset-adjusted positions or change the assertion strategy (e.g., check for segment presence without relying on exact pixel values).

🤖 Fix all issues with AI agents
In `@packages/renderer/src/index.ts`:
- Line 92: Fix the minor comment typo in packages/renderer/src/index.ts by
changing the comment text in the tapering logic comment (near the
renderAnimatedSVG-related code) from "Tapering logic matchin renderAnimatedSVG"
to "Tapering logic matching renderAnimatedSVG" so the comment correctly reads
"matching".
🧹 Nitpick comments (1)
README.md (1)

133-145: Consider simplifying the wording.

The phrase "prefer to have" on line 135 is a bit wordy. A more direct phrasing would read better.

✏️ Suggested simplification
-If you prefer to have the tool available globally:
+To install the tool globally:

Comment thread packages/renderer/src/index.ts Resolved
miccy and others added 2 commits January 29, 2026 16:27
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Miccy <code@miccy.dev>
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com>
Signed-off-by: Miccy <code@miccy.dev>
Comment thread packages/github/src/index.ts Resolved
Co-authored-by: kiloconnect[bot] <240665456+kiloconnect[bot]@users.noreply.github.com>
Signed-off-by: Miccy <code@miccy.dev>
@miccy
miccy merged commit 42e6db6 into main Jan 29, 2026
10 checks passed
@miccy
miccy deleted the v1.3.0 branch April 21, 2026 05:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bug Something isn't working docs Improvements or additions to documentation feat New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Release v1.3.0

2 participants